home *** CD-ROM | disk | FTP | other *** search
/ Complete Linux / Complete Linux.iso / docs / system / mail / transpor / ifmail23.z / ifmail23 / ifmail / ifcico / README < prev    next >
Encoding:
Text File  |  1994-05-08  |  5.0 KB  |  111 lines

  1. Copyright (c) 1993, 1994 Eugene G. Crosser
  2.  
  3. ifcico is a FidoNet(tm) compatible mailer for U*IX platforms.
  4.  
  5. You may do virtually what you wish with this software, as long as the
  6. explicit reference to its original author is retained:
  7.  
  8. Eugene G. Crosser <crosser@pccross.msk.su>, 2:5020/230@FidoNet
  9.  
  10. THIS SOFTWARE IS PROVIDED AS IS AND COME WITH NO WARRANTY OF ANY KIND,
  11. EITHER EXPRESSED OR IMPLIED.  IN NO EVENT WILL THE COPYRIGHT HOLDER BE
  12. LIABLE FOR ANY DAMAGES RESULTING FROM THE USE OF THIS SOFTWARE.
  13.  
  14. This is a BETA version, it is far from being fully tested.  If you think
  15. that you found a bug, contact the author at crosser@pccross.msk.su.
  16.  
  17. All programs show a small help message when run with "-h" flag.
  18.  
  19. "ifcico" stands for "Internet - Fidonet Copy In / Copy Out", this is a
  20. FidoNet(tm) compatible transport agent.  Currently it supports FTS-0001,
  21. YooHoo/2U2 and EMSI handshake protocols, Xmodem (untested), Telink
  22. (untested), Modem7 (untested), SEAlink w/overdrive and crash recovery,
  23. Bark file and update requests, WaZOO protocols: DietIFNA, plain Zmodem
  24. (aka ZedZip, EMSI flag "ZMO") and ZedZap, WaZOO file and update requests
  25. (nodelist flag should be XA).  Password protected requests are not
  26. implemented.  There are plans to implement Janus (and maybe Hydra)
  27. protocols in the future.
  28.  
  29. Outbound directory structure is BinkleyTerm compatible, with domains and
  30. point subdirectories (full 5d).  There are separate "listed" and
  31. "protected" inbound directories for the incoming sessions with the nodes
  32. present in the nodelist(s) and with nodes that have a password assigned
  33. respectively.  Files received during an outbound session are always put
  34. into the "protected" directory. (Only "protected" directory is looked up
  35. by ifunpack by default, see ifgate subdir).
  36.  
  37. "Magic" file request processors are executable files placed in the
  38. "magic" directory.  If request is made for a file with matching name,
  39. the executable from the "magic" directory is run, and its stdout sent to
  40. the requestor.  Full requestor's address, in the form "John Smith of
  41. 1:234/56.7" is passed to the executable in the command line.  See
  42. "misc/FILES" for an example of a magic request processor.
  43.  
  44. To make ifcico work in answer mode, you need a hack in uugetty. Provided
  45. are diffs for Linux getty_ps 2.0.7c, named GETTY.diff.  Gert Doering's
  46. mgetty .17 (from the mgetty+sendfax package) and later versions have
  47. fidonet support built-in.  Getty_ps 2.0.7d and further versions are
  48. supposed to have fidonet support too.  Getty must distinguish incoming
  49. FidoNet type calls, and start ifcico with one parameter:
  50.  
  51. FTS-0001 call:        "ifcico tsync"
  52. FTS-0006 call:        "ifcico yoohoo"
  53. EMSI call:        "ifcico **EMSI_....."
  54.  
  55. (in the latter case the received EMSI packet should be passed without
  56. trailing CR).
  57.  
  58. If you are using getty_ps, don't forget to (a) #define FIDO in tune.h,
  59. and (b) create the file /etc/default/uugetty with the contents similar
  60. to the following (case sensitive):
  61.  
  62. FIDO=/usr/local/lib/fnet/ifcico
  63. EMSI=yes
  64.  
  65. It is also recommended to increase getty's input buffer size to 0.5 - 1
  66. Kb (in tune.h).
  67.  
  68. When called without parameters, ifcico runs in slave mode and determines
  69. the type of inbound session itself.  This mode may be used when ifcico
  70. runs as an internet or ISDN daemon.
  71.  
  72. To make ifcico scan for pending outbound mail and do appropriate calls,
  73. start it with "-r1" flag.  To force polling of particular nodes, specify
  74. these nodes in the command line (addresses should be in domain notation,
  75. e.g. "ifcico f23.n5020 f155.n5020").  The latter implies master mode
  76. (-r1).  Note that "hold" packets and files, as well as file requests, do
  77. not cause the node to be polled.
  78.  
  79. Inbound directory is created automatically if it does not exist, along
  80. with the "tmp" subdir. The latter is used while receiving files. After
  81. being successfully received, the files are moved up to the "inbound"
  82. directory.
  83.  
  84. Almost all features are controlled by the configuration file. See
  85. "misc/config" file as an example, it contains a lot of comments.  To use
  86. ifcico over TCP/IP, see "services" file with an example line for the
  87. service entry, and "initd.conf" file with an example how to make ifcico
  88. listen for incoming connects.  To initiate outgoing TCP/IP connect, use
  89. "-a" flag.
  90.  
  91. Ifcico can use text format nodelists in original (MS/DOS) form with
  92. <CR><LF>'s as well as in UNIX form, with <LF>'s only.  When you get
  93. a fresh nodelist, or change the "nodelist" statements in the config
  94. file, you must rebuild index with "ifindex" program.
  95.  
  96. ifstat program shows a summary of pending outbound mail.
  97.  
  98. ifroute program (not working yet - under development) can be used in a
  99. "queryprogram" driver with Smail.  It accepts destination address on the
  100. commend line and writes routing address to stdout, taking care of
  101. hub/host/zonegate routing.
  102.  
  103. sumlog is a simple example perl script to count session durations.
  104.  
  105. Acknowlegements:
  106.  
  107. Some ideas taken from FidoGate-RFmail package written by Teemu Torma and
  108. hacked by Martin Junius. Several source modules taken from INN 1.4 package.
  109. Zmodem source taken from sz/rz programs by Chuck Forsberg (I may rewrite
  110. it from scratch in future).
  111.